/**
 *    Copyright 2009-2019 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.reflection;

import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.property.PropertyTokenizer;
import org.apache.ibatis.reflection.wrapper.*;

import java.util.Collection;
import java.util.List;
import java.util.Map;

/**
 * 对象元数据
 *
 * @author Clinton Begin
 */
public class MetaObject {
    /**
     * 被包装的原始对象
     */
    private final Object originalObject;
    /**
     * 原始对象的包装器
     */
    private final ObjectWrapper objectWrapper;
    /**
     * 实例化对象的工厂
     */
    private final ObjectFactory objectFactory;
    /**
     * 创建对象包装器的工厂
     */
    private final ObjectWrapperFactory objectWrapperFactory;
    /**
     * 创建Reflector对象的反射工厂
     */
    private final ReflectorFactory reflectorFactory;

    /**
     * @param object               原始对象
     * @param objectFactory        对象工厂
     * @param objectWrapperFactory 对象包装工厂
     * @param reflectorFactory     反射工厂
     */
    private MetaObject(Object object, ObjectFactory objectFactory, ObjectWrapperFactory objectWrapperFactory, ReflectorFactory reflectorFactory) {
        // 初始化被包装的原始对象
        this.originalObject = object;
        // 初始化实例化对象的工厂类
        this.objectFactory = objectFactory;
        // 初始化创建对象包装器的工厂类
        this.objectWrapperFactory = objectWrapperFactory;
        // 初始化用于获取类描述对象的工厂类
        this.reflectorFactory = reflectorFactory;

        // 为原始对象创建对象包装器

        if (object instanceof ObjectWrapper) {
            // 无需包装
            this.objectWrapper = (ObjectWrapper) object;
        } else if (objectWrapperFactory.hasWrapperFor(object)) {
            // 通过包装器工厂进行包装
            this.objectWrapper = objectWrapperFactory.getWrapperFor(this, object);
        } else if (object instanceof Map) {
            this.objectWrapper = new MapWrapper(this, (Map) object);
        } else if (object instanceof Collection) {
            this.objectWrapper = new CollectionWrapper(this, (Collection) object);
        } else {
            this.objectWrapper = new BeanWrapper(this, object);
        }
    }

    /**
     * 生成对象元数据
     *
     * @param object               对象
     * @param objectFactory        对象工厂
     * @param objectWrapperFactory 对象包装工厂
     * @param reflectorFactory     反射工厂
     * @return 对象元数据
     */
    public static MetaObject forObject(Object object, ObjectFactory objectFactory, ObjectWrapperFactory objectWrapperFactory, ReflectorFactory reflectorFactory) {
        if (object == null) {
            // 返回空对象元数据
            return SystemMetaObject.NULL_META_OBJECT;
        } else {
            // 生成对象元数据
            return new MetaObject(object, objectFactory, objectWrapperFactory, reflectorFactory);
        }
    }

    public ObjectFactory getObjectFactory() {
        return objectFactory;
    }

    public ObjectWrapperFactory getObjectWrapperFactory() {
        return objectWrapperFactory;
    }

    public ReflectorFactory getReflectorFactory() {
        return reflectorFactory;
    }

    public Object getOriginalObject() {
        return originalObject;
    }

    /**
     * 查找属性名称
     *
     * @param propName            用于获取实际属性名的名称描述符，比如可以通过name获取Name，或者Name获取name。
     * @param useCamelCaseMapping 是否使用驼峰命名法，即下划线转驼峰，比如通过first_name 获取firstName属性
     * @return 实际属性名称
     */
    public String findProperty(String propName, boolean useCamelCaseMapping) {
        return objectWrapper.findProperty(propName, useCamelCaseMapping);
    }

    /**
     * 获取所有可读属性名
     *
     * @return 可读属性名集合
     */
    public String[] getGetterNames() {
        return objectWrapper.getGetterNames();
    }

    /**
     * 获取所有可写属性名
     *
     * @return 可写属性名集合
     */
    public String[] getSetterNames() {
        return objectWrapper.getSetterNames();
    }

    /**
     * 获取指定属性的setter方法入参类型
     *
     * @param name 属性名
     * @return 该属性setter方法入参类型
     */
    public Class<?> getSetterType(String name) {
        return objectWrapper.getSetterType(name);
    }

    /**
     * 获取指定属性的getter方法返回类型
     *
     * @param name 属性名称
     * @return 该属性的getter方法的返回类型
     */
    public Class<?> getGetterType(String name) {
        return objectWrapper.getGetterType(name);
    }

    /**
     * 是否有指定名称属性的setter方法
     *
     * @param name 指定属性名称
     */
    public boolean hasSetter(String name) {
        return objectWrapper.hasSetter(name);
    }

    /**
     * 是否有指定名称属性的getter方法
     *
     * @param name 指定属性名称
     */
    public boolean hasGetter(String name) {
        return objectWrapper.hasGetter(name);
    }

    /**
     * 获取指定属性的值
     *
     * @param name 属性名称
     * @return 属性值
     */
    public Object getValue(String name) {
        // 将传入的属性名生成属性迭代器
        PropertyTokenizer prop = new PropertyTokenizer(name);
        if (prop.hasNext()) {
            // 获取属性值对应的MetaObject
            MetaObject metaValue = metaObjectForProperty(prop.getIndexedName());
            if (metaValue == SystemMetaObject.NULL_META_OBJECT) {
                // 当前属性是空对象，子类自然不存在值
                return null;
            } else {
                // 递归处理属性描述符
                return metaValue.getValue(prop.getChildren());
            }
        } else {
            // 真正获取属性值
            return objectWrapper.get(prop);
        }
    }

    /**
     * 未指定的属性赋值
     * @param name 属性名称
     * @param value 属性值
     */
    public void setValue(String name, Object value) {

        PropertyTokenizer prop = new PropertyTokenizer(name);
        if (prop.hasNext()) {
            // [param.id]
            // 获取指定名称的值的对象元数据
            MetaObject metaValue = metaObjectForProperty(prop.getIndexedName());
            if (metaValue == SystemMetaObject.NULL_META_OBJECT) {
                if (value == null) {
                    // 保存的值为null，没有必要实例化
                    // don't instantiate child path if value is null
                    return;
                } else {
                    // 实例化属性值
                    metaValue = objectWrapper.instantiatePropertyValue(name, prop, objectFactory);
                }
            }
            // 保存属性对应的值
            metaValue.setValue(prop.getChildren(), value);
        } else {
            // [id]
            // 保存值
            objectWrapper.set(prop, value);
        }
    }

    /**
     * 将指定属性的值包装成元数据对象
     *
     * @param name 名称
     * @return 指定名称的值的对象元数据
     */
    public MetaObject metaObjectForProperty(String name) {
        // 从对象元数据中获取指定名称的属性值
        Object value = getValue(name);
        // 生成该值对应的对象元数据
        return MetaObject.forObject(value, objectFactory, objectWrapperFactory, reflectorFactory);
    }

    public ObjectWrapper getObjectWrapper() {
        return objectWrapper;
    }

    /**
     * 维护的对象是否是集合类型
     */
    public boolean isCollection() {
        return objectWrapper.isCollection();
    }

    /**
     * 往维护集合对象中添加一个元素
     */
    public void add(Object element) {
        objectWrapper.add(element);
    }

    /**
     * 往维护集合对象中添加一组元素
     */
    public <E> void addAll(List<E> list) {
        objectWrapper.addAll(list);
    }

}
